<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IRepeater,mx.core.IRepeater,container,count,currentIndex,currentItem,dataProvider,recycleChildren,startingIndex,executeChildBindings,initializeRepeater" name="keywords">
<title>mx.core.IRepeater</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IRepeater - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/core/IRepeater.html&amp;mx/core/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IRepeater</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IRepeater"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.core</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IRepeater</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="../core/UIComponent.html">UIComponent</a></td>
</tr>
</table>
<p></p>
  The IRepeater interface defines the APIs for Repeater
  public APIs of the Repeater object.
 <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#container">container</a> : <a href="../core/IContainer.html">IContainer</a>
<div class="summaryTableDescription">[read-only]
      The container that contains this Repeater,
   and in which it will create its children.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#count">count</a> : int<div class="summaryTableDescription">
      The number of times this Repeater should execute.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#currentIndex">currentIndex</a> : int<div class="summaryTableDescription">[read-only]
      The index of the item in the <code>dataProvider</code> currently
   being processed while this Repeater is executing.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#currentItem">currentItem</a> : Object<div class="summaryTableDescription">[read-only]
      The item in the <code>dataProvider</code> currently being processed
   while this Repeater is executing.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#dataProvider">dataProvider</a> : Object<div class="summaryTableDescription">
      The data provider used by this Repeater to create repeated instances
   of its children.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#recycleChildren">recycleChildren</a> : Boolean<div class="summaryTableDescription">
      A Boolean flag indicating whether this Repeater should re-use
   previously created children, or create new ones.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#startingIndex">startingIndex</a> : int<div class="summaryTableDescription">
      The index into the <code>dataProvider</code> at which this Repeater
      starts creating children.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#executeChildBindings()">executeChildBindings</a>():void</div>
<div class="summaryTableDescription">
      Executes the bindings into all the UIComponents created
   by this Repeater.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#initializeRepeater()">initializeRepeater</a>(container:<a href="IContainer.html">IContainer</a>, recurse:Boolean):void</div>
<div class="summaryTableDescription">
      Initializes a new Repeater object.</div>
</td><td class="summaryTableOwnerCol">IRepeater</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="container"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">container</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>container:<a href="../core/IContainer.html">IContainer</a></code>&nbsp;&nbsp;[read-only]<p>
      The container that contains this Repeater,
   and in which it will create its children.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get container():<a href="../core/IContainer.html">IContainer</a></code>
<br>
</div>
<a name="count"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">count</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>count:int</code>&nbsp;&nbsp;[read-write]<p>
      The number of times this Repeater should execute.
        </p><p>If the Repeater reaches the end of the data provider while
   executing, the number of times it actually executes will be less
   that the requested count.</p>
     <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get count():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set count(value:int):void</code>
<br>
</div>
<a name="currentIndex"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">currentIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>currentIndex:int</code>&nbsp;&nbsp;[read-only]<p>
      The index of the item in the <code>dataProvider</code> currently
   being processed while this Repeater is executing.
     </p><p>After the Repeater has finished executing,
   this property is <code>-1</code>.
   However, the <code>repeaterIndex</code> property of a repeated
   component instance remembers the index of the
   <code>dataProvider</code> item from which it was created.
   In the case of nested Repeaters, you can use the
   <code>repeaterIndices</code> array.</p>
     <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get currentIndex():int</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../core/UIComponent.html#repeaterIndex" target="">mx.core.UIComponent.repeaterIndex</a>
<br>
<a href="../core/UIComponent.html#repeaterIndices" target="">mx.core.UIComponent.repeaterIndices</a>
<br>
<a href="../core/UIComponent.html#instanceIndex" target="">mx.core.UIComponent.instanceIndex</a>
<br>
<a href="../core/UIComponent.html#instanceIndices" target="">mx.core.UIComponent.instanceIndices</a>
</div>
</div>
<a name="currentItem"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">currentItem</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>currentItem:Object</code>&nbsp;&nbsp;[read-only]<p>
      The item in the <code>dataProvider</code> currently being processed
   while this Repeater is executing.
     </p><p>After the Repeater has finished executing,
   this property is <code>null</code>.
   However, in this case you can call the <code>getRepeaterItem()</code>
   method of the repeated component instance to get the
   <code>dataProvider</code> item from which it was created.</p>
     <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get currentItem():Object</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../core/UIComponent.html#getRepeaterItem()" target="">mx.core.UIComponent.getRepeaterItem()</a>
</div>
</div>
<a name="dataProvider"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dataProvider</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>dataProvider:Object</code>&nbsp;&nbsp;[read-write]<p>
      The data provider used by this Repeater to create repeated instances
   of its children.
   
   </p><p>If you read the <code>dataProvider</code> property, you always get
   an ICollectionView object or <code>null</code>.
   If you set the <code>dataProvider</code> property to anything other than
   <code>null</code>, it is converted into an ICollectionView object,
   according the following rules:</p>
     <ul>
     <li>If you set it to an Array, it is converted into an ArrayCollection.</li>
     <li>If you set it to an ICollectionView, no conversion is performed.</li>
     <li>If you set it to an IList, it is converted into a ListCollectionView.</li>
     <li>If you set it to an XML or XMLList, it is converted
       into an XMLListCollection.</li>
     <li>Otherwise, it is converted to a single-element ArrayCollection.</li>
   </ul>
           <p>You must specify a value for the <code>dataProvider</code> property 
      or the Repeater component will not execute.</p>
     <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get dataProvider():Object</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set dataProvider(value:Object):void</code>
<br>
</div>
<a name="recycleChildren"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">recycleChildren</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>recycleChildren:Boolean</code>&nbsp;&nbsp;[read-write]<p>
      A Boolean flag indicating whether this Repeater should re-use
   previously created children, or create new ones.
     </p><p>If <code>true</code>, when this Repeater's
   <code>dataProvider</code>, <code>startingIndex</code>,
   or <code>count</code> changes, it will recycle the existing
   children by binding the new data into them.
   If more children are required, they are created and added.
   If fewer children are required, the extra ones are removed
   and garbage collected.</p>
           <p>If <code>false</code>, when this Repeater's 
   <code>dataProvider</code>, <code>startingIndex</code>,
   or <code>count</code> changes, it will remove any previous
   children that it created and then create and 
      add new children from the new data items.</p>
     <p>This property is <code>false</code> by default.
   Setting it to <code>true</code> can increase performance,
   but is not appropriate in all situations.
   For example, if the previously created children have state
   information such as text typed in by a user, then this
   state will not get reset when the children are recycled.</p>
     <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get recycleChildren():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set recycleChildren(value:Boolean):void</code>
<br>
</div>
<a name="startingIndex"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">startingIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>startingIndex:int</code>&nbsp;&nbsp;[read-write]<p>
      The index into the <code>dataProvider</code> at which this Repeater
      starts creating children.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get startingIndex():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set startingIndex(value:int):void</code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="executeChildBindings()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">executeChildBindings</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function executeChildBindings():void</code><p>
      Executes the bindings into all the UIComponents created
   by this Repeater.
     </p><p>This method is called by the Flex framework.
   Developers should not need to call it.</p>
     </div>
<a name="initializeRepeater()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">initializeRepeater</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function initializeRepeater(container:<a href="IContainer.html">IContainer</a>, recurse:Boolean):void</code><p>
      Initializes a new Repeater object.
     </p><p>This method is called by the Flex framework.
   Developers should not need to call it.</p>
        <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">container</span>:<a href="IContainer.html">IContainer</a></code> &mdash; The Container that contains this Repeater,
   and in which this Repeater will create its children.
        </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">recurse</span>:Boolean</code> &mdash; A Boolean flag indicating whether this Repeater
   should create all descendants of its children.
     </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
